docs: improve README clarity and add quick start section#2021
docs: improve README clarity and add quick start section#2021mohithshuka wants to merge 1 commit intoCCExtractor:masterfrom
Conversation
cfsmp3
left a comment
There was a problem hiding this comment.
Thank you for working on improving the README! However, there are a few issues that need to be addressed before this can be merged.
Issues Found
1. Typo Introduced
The PR accidentally removes the word "a" from an existing sentence:
- Before: "subtitles are a great way to learn"
- After: "subtitles are great way to learn"
This is grammatically incorrect.
2. Broken Markdown
The code block in the Quick Start section is not properly closed - it's missing the closing ```. This will break the README rendering.
3. Redundant Content
The same command already exists in the README at lines 50-54:
Extracting subtitles is relatively simple. Just run the following command:
`ccextractor <input>`
This will extract the subtitles.Adding it again in a Quick Start section creates duplication.
4. Document Flow
The Quick Start section is inserted between "Installation and Usage" and "Windows Package Managers", which breaks the logical hierarchy. The Windows Package Managers section was meant to be grouped under Installation.
Suggestions
Option A: Keep it simple - just submit the repository link formatting fix (which is good!) as a separate small PR, and drop the Quick Start section.
Option B: If you want to add a Quick Start section, consider:
- Placing it right after the introduction (before Installation)
- Including BOTH installation and basic usage
- Removing the duplicate content from below
- Making sure it's properly formatted
What's Good
The repository link change is genuinely better:
- Removes unnecessary parentheses
- Uses proper punctuation
- Formats
masteras inline code
Please fix these issues and I'll be happy to review again!
|
Closing this PR. Issues were previously identified on Jan 15:
These issues were pointed out but not addressed. Additionally, all recent PRs from this author have had similar quality issues (empty descriptions, mixed concerns, duplicate submissions, build failures). Please ensure PRs are:
|
In raising this pull request, I confirm the following (please check boxes):
My familiarity with the project is as follows (check one):
{pull request content here}